<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Get Elasticsearch up and running | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="getting-started.html" title="Getting started with Elasticsearch">
<link rel="prev" href="getting-started.html" title="Getting started with Elasticsearch">
<link rel="next" href="getting-started-index.html" title="Index some documents">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="getting-started.html">Getting started with Elasticsearch</a></span>
»
<span class="breadcrumb-node">Get Elasticsearch up and running</span>
</div>
<div class="navheader">
<span class="prev">
<a href="getting-started.html">« Getting started with Elasticsearch</a>
</span>
<span class="next">
<a href="getting-started-index.html">Index some documents »</a>
</span>
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="getting-started-install"></a>Get Elasticsearch up and running<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/getting-started.asciidoc">edit</a>
</h2>
</div></div></div>
<p>To take Elasticsearch for a test drive, you can create a
<a href="/cloud/elasticsearch-service/signup?baymax=docs-body&amp;elektra=docs" class="ulink" target="_top">hosted deployment</a>  on
the Elasticsearch Service or set up a multi-node Elasticsearch cluster on your own
Linux, macOS, or Windows machine.</p>
<h3>
<a id="run-elasticsearch-hosted"></a>Run Elasticsearch on Elastic Cloud<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/getting-started.asciidoc">edit</a>
</h3>
<p>When you create a deployment on the Elasticsearch Service, the service provisions
a three-node Elasticsearch cluster along with Kibana and APM.</p>
<p>To create a deployment:</p>
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Sign up for a <a href="/cloud/elasticsearch-service/signup?baymax=docs-body&amp;elektra=docs" class="ulink" target="_top">free trial</a>
and verify your email address.
</li>
<li class="listitem">
Set a password for your account.
</li>
<li class="listitem">
Click <span class="strong strong"><strong>Create Deployment</strong></span>.
</li>
</ol>
</div>
<p>Once you’ve created a deployment, you’re ready to <a class="xref" href="getting-started-index.html" title="Index some documents"><em>Index some documents</em></a>.</p>
<h3>
<a id="run-elasticsearch-local"></a>Run Elasticsearch locally on Linux, macOS, or Windows<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/getting-started.asciidoc">edit</a>
</h3>
<p>When you create a deployment on the Elasticsearch Service, a master node and
two data nodes are provisioned automatically. By installing from the tar or zip
archive, you can start multiple instances of Elasticsearch locally to see how a multi-node
cluster behaves.</p>
<p>To run a three-node Elasticsearch cluster locally:</p>
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
<p>Download the Elasticsearch archive for your OS:</p>
<p>Linux: <a href="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.7.1-linux-x86_64.tar.gz" class="ulink" target="_top">elasticsearch-7.7.1-linux-x86_64.tar.gz</a></p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.7.1-linux-x86_64.tar.gz</pre>
</div>
<p>macOS: <a href="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.7.1-darwin-x86_64.tar.gz" class="ulink" target="_top">elasticsearch-7.7.1-darwin-x86_64.tar.gz</a></p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.7.1-darwin-x86_64.tar.gz</pre>
</div>
<p>Windows:
<a href="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.7.1-windows-x86_64.zip" class="ulink" target="_top">elasticsearch-7.7.1-windows-x86_64.zip</a></p>
</li>
<li class="listitem">
<p>Extract the archive:</p>
<p>Linux:</p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">tar -xvf elasticsearch-7.7.1-linux-x86_64.tar.gz</pre>
</div>
<p>macOS:</p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">tar -xvf elasticsearch-7.7.1-darwin-x86_64.tar.gz</pre>
</div>
<p>Windows PowerShell:</p>
<div class="pre_wrapper lang-powershell">
<pre class="programlisting prettyprint lang-powershell">Expand-Archive elasticsearch-7.7.1-windows-x86_64.zip</pre>
</div>
</li>
<li class="listitem">
<p>Start Elasticsearch from the <code class="literal">bin</code> directory:</p>
<p>Linux and macOS:</p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">cd elasticsearch-7.7.1/bin
./elasticsearch</pre>
</div>
<p>Windows:</p>
<div class="pre_wrapper lang-powershell">
<pre class="programlisting prettyprint lang-powershell">cd elasticsearch-7.7.1\bin
.\elasticsearch.bat</pre>
</div>
<p>You now have a single-node Elasticsearch cluster up and running!</p>
</li>
<li class="listitem">
<p>Start two more instances of Elasticsearch so you can see how a typical multi-node
cluster behaves. You need to specify unique data and log paths
for each node.</p>
<p>Linux and macOS:</p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">./elasticsearch -Epath.data=data2 -Epath.logs=log2
./elasticsearch -Epath.data=data3 -Epath.logs=log3</pre>
</div>
<p>Windows:</p>
<div class="pre_wrapper lang-powershell">
<pre class="programlisting prettyprint lang-powershell">.\elasticsearch.bat -E path.data=data2 -E path.logs=log2
.\elasticsearch.bat -E path.data=data3 -E path.logs=log3</pre>
</div>
<p>The additional nodes are assigned unique IDs. Because you’re running all three
nodes locally, they automatically join the cluster with the first node.</p>
</li>
<li class="listitem">
<p>Use the cat health API to verify that your three-node cluster is up running.
The cat APIs return information about your cluster and indices in a
format that’s easier to read than raw JSON.</p>
<p>You can interact directly with your cluster by submitting HTTP requests to
the Elasticsearch REST API. If you have Kibana installed and running, you can also
open Kibana and submit requests through the Dev Console.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>You’ll want to check out the
<a href="/guide/en/elasticsearch/client/index.html" class="ulink" target="_top">Elasticsearch language
clients</a> when you’re ready to start using Elasticsearch in your own applications.</p>
</div>
</div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/health?v</pre>
</div>
<div class="console_widget" data-snippet="snippets/1.console"></div>
<p>The response should indicate that the status of the <code class="literal">elasticsearch</code> cluster
is <code class="literal">green</code> and it has three nodes:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">epoch      timestamp cluster       status node.total node.data shards pri relo init unassign pending_tasks max_task_wait_time active_shards_percent
1565052807 00:53:27  elasticsearch green           3         3      6   3    0    0        0             0                  -                100.0%</pre>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The cluster status will remain yellow if you are only running a single
instance of Elasticsearch. A single node cluster is fully functional, but data
cannot be replicated to another node to provide resiliency. Replica shards must
be available for the cluster status to be green. If the cluster status is red,
some data is unavailable.</p>
</div>
</div>
</li>
</ol>
</div>
<h3>
<a id="gs-curl"></a>Talking to Elasticsearch with cURL commands<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/getting-started.asciidoc">edit</a>
</h3>
<p>Most of the examples in this guide enable you to copy the appropriate cURL
command and submit the request to your local Elasticsearch instance from the command line.</p>
<p>A request to Elasticsearch consists of the same parts as any HTTP request:</p>
<div class="pre_wrapper lang-sh">
<pre class="programlisting prettyprint lang-sh">curl -X&lt;VERB&gt; '&lt;PROTOCOL&gt;://&lt;HOST&gt;:&lt;PORT&gt;/&lt;PATH&gt;?&lt;QUERY_STRING&gt;' -d '&lt;BODY&gt;'</pre>
</div>
<p>This example uses the following variables:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;VERB&gt;</code>
</span>
</dt>
<dd>
The appropriate HTTP method or verb. For example, <code class="literal">GET</code>, <code class="literal">POST</code>,
<code class="literal">PUT</code>, <code class="literal">HEAD</code>, or <code class="literal">DELETE</code>.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;PROTOCOL&gt;</code>
</span>
</dt>
<dd>
Either <code class="literal">http</code> or <code class="literal">https</code>. Use the latter if you have an HTTPS
proxy in front of Elasticsearch or you use Elasticsearch security features to encrypt HTTP
communications.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;HOST&gt;</code>
</span>
</dt>
<dd>
The hostname of any node in your Elasticsearch cluster. Alternatively, use
<code class="literal">localhost</code> for a node on your local machine.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;PORT&gt;</code>
</span>
</dt>
<dd>
The port running the Elasticsearch HTTP service, which defaults to <code class="literal">9200</code>.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;PATH&gt;</code>
</span>
</dt>
<dd>
The API endpoint, which can contain multiple components, such as
<code class="literal">_cluster/stats</code> or <code class="literal">_nodes/stats/jvm</code>.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;QUERY_STRING&gt;</code>
</span>
</dt>
<dd>
Any optional query-string parameters. For example, <code class="literal">?pretty</code>
will <em>pretty-print</em>  the JSON response to make it easier to read.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;BODY&gt;</code>
</span>
</dt>
<dd>
A JSON-encoded request body (if necessary).
</dd>
</dl>
</div>
<p>If the Elasticsearch security features are enabled, you must also provide a valid user
name (and password) that has authority to run the API. For example, use the
<code class="literal">-u</code> or <code class="literal">--u</code> cURL command parameter. For details about which security
privileges are required to run each API, see <a class="xref" href="rest-apis.html" title="REST APIs">REST APIs</a>.</p>
<p>Elasticsearch responds to each API request with an HTTP status code like <code class="literal">200 OK</code>. With
the exception of <code class="literal">HEAD</code> requests, it also returns a JSON-encoded response body.</p>
<h3>
<a id="gs-other-install"></a>Other installation options<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/getting-started.asciidoc">edit</a>
</h3>
<p>Installing Elasticsearch from an archive file enables you to easily install and run
multiple instances locally so you can try things out. To run a single instance,
you can  run Elasticsearch in a Docker container, install Elasticsearch using the DEB or RPM
packages on Linux, install using Homebrew on macOS, or install using the MSI
package installer on Windows. See <a class="xref" href="install-elasticsearch.html" title="Installing Elasticsearch"><em>Installing Elasticsearch</em></a> for more information.</p>
</div>
<div class="navfooter">
<span class="prev">
<a href="getting-started.html">« Getting started with Elasticsearch</a>
</span>
<span class="next">
<a href="getting-started-index.html">Index some documents »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
